Revert docs#214 heading demotion on deep pages (restore anchors) - #228
Open
eyalb181 wants to merge 1 commit into
Open
Revert docs#214 heading demotion on deep pages (restore anchors)#228eyalb181 wants to merge 1 commit into
eyalb181 wants to merge 1 commit into
Conversation
…ors) docs#214 demoted body headings by one level to remove a duplicate H1. On these 10 deeply-nested pages that pushed real H3 subheadings to H4, and GitBook only generates anchor links for H1-H3 — so they silently lost their deep-link anchors and dropped out of the page outline. Un-demote those pages (exact inverse: remove one '#' per heading, code fences untouched), restoring the H3-level anchors. Descriptions and other content are preserved. The reinstated body '#' H1 re-creates the "multiple H1" the audit flagged (Trivial) — accepted, since GitBook's page-title-is-H1 model makes single-H1 and fully-anchored multi-level content mutually exclusive here, and anchors matter more. (quick-start and preview-environments were shallow and keep the #214 demotion.) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
eyalb181
force-pushed
the
seo/revert-h1-demotion
branch
from
June 18, 2026 15:32
a83bc0b to
0d35465
Compare
RinkiyaKeDad
requested changes
Jun 18, 2026
| mirrord supports two ways of specifying how to connect to the source database: a full **connection URL** or **individual connection parameters**. | ||
|
|
||
| #### Connection URL | ||
| ### Connection URL |
Collaborator
There was a problem hiding this comment.
this should be a h2 no since it's directly under a h1?
| - `"env_from"`: From the target pod's `envFrom` field (`secretRef` or `configMapRef`). mirrord replicates the `envFrom` sources onto the init container so it can resolve the variable at runtime. | ||
|
|
||
| #### Individual Connection Parameters (Params) | ||
| ### Individual Connection Parameters (Params) |
| ``` | ||
|
|
||
| #### Secret Source | ||
| ### Secret Source |
Collaborator
There was a problem hiding this comment.
here as well and the bunch below this
| ``` | ||
|
|
||
| ##### In this example | ||
| #### In this example |
Collaborator
There was a problem hiding this comment.
Here again this can be a h2 if not h3
| {% endhint %} | ||
|
|
||
| #### MongoDB Collection Filters | ||
| ### MongoDB Collection Filters |
| {% endhint %} | ||
|
|
||
| #### Architecture | ||
| ### Architecture |
Collaborator
There was a problem hiding this comment.
why not make this h1?
| Authentication between the operator and license server is done using a license key (chosen by the person setting up the license server) and is not to be confused with the license certificate file provided by MetalBear. | ||
|
|
||
| #### Basic Setup | ||
| ### Basic Setup |
Collaborator
There was a problem hiding this comment.
if we h1 this then we can h2 "using cluster secret" which is supposed to be under "basic setup" right?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reverts the heading demotion from docs#214 on 10 deeply-nested pages, because it cost more than it bought.
Why
docs#214 demoted body headings one level to fix a duplicate H1 (audit "Non-Sequential H1", Trivial). On deeply-nested pages that pushed real H3 subheadings to H4 — and GitBook only anchors H1–H3, so those headings silently lost their deep-link anchors and dropped out of the page outline. (E.g. queue-splitting had 21 headings go H3→H4.)
What
Un-demote the 10 affected pages (exact inverse of #214: remove one
#per heading; code-fence#comments untouched). This restores the H3-level anchors. Pages:admin-dashboard,license-server,monitoring,operator,db-branching-advanced-config,queue-splitting,troubleshooting/utilities,use-cases/mirrord-for-ci,multi-cluster-setup,multiple-concurrent-sessions.quick-startandpreview-environmentswere shallow (≤2 body levels) — #214 was clean there, so they're left as-is. The meta descriptions #214 added are preserved.Trade-off
The restored body
#re-creates the duplicate H1 the audit flagged (Trivial, Google-tolerated). GitBook's page-title-is-H1 model means single-H1 and fully-anchored multi-level content can't both hold on these pages — anchors win. (The very deepest H4/H5 levels still won't anchor; truly fixing that needs editorial flattening, separate work.)🤖 Generated with Claude Code